Import a Theme

Imports a theme definition from a 'PAT' file.

From Pyramid 2025.02 onwards, hardened security infrastructure has necessitated a change to the internal format of PIE and PAT files. If you are importing an older PAT file (exported from Pyramid 2018 or Pyramid 2020 versions) and receive an error “Unknown file format”, the PAT file needs to be upgraded to the new format before importing.

See PIE and PAT export file converter for more details.

Method

/API3/themes/importTheme

  • API Section: /API3/themes
  • API Version: 3.0
  • From Release: 2023.10
  • Usage: REST API and Client SDK libraries. REST APIs via POST actions only.
  • Usage by:
    • Enterprise Admin

Method Signature

Input Parameters

Name

themeApiObject

Object Type

ThemeApiObject

Description

The theme object holding the definition of a theme.

Output Response

Successful Result Code

200

Response Type

CreatedThemeResult

Description of Response Type

The returned Object when importing a theme.

Notes

Theme can be exported via the admin console or API. These can then be imported using this method.

Code Snippets

Use the Authentication API methods to generate an access 'key' or 'token' for use in code as shown below.

TypeScript
Curl
Java
C#
Python
PHP
curl -X POST \
-H "paToken: [[apiKey]]" \
 -H "Accept: application/json,application/json;charset=utf-8,text/plain,text/plain;charset=utf-8" \
 -H "Content-Type: application/json" \
 "http://Your.Server.URL/API3/themes/importTheme" \
 -d '{
  "themeName" : "themeName",
  "themeData" : "themeData",
  "isDefault" : true,
  "themeId" : "themeId"
}'

import com.pyramidanalytics.*;
import com.pyramidanalytics.auth.*;
import com.pyramidanalytics.model.*;
import com.pyramidanalytics.api.ThemesServiceApi;

import java.util.*;
import java.time.*;

public class ThemesServiceApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("http://Your.Server.URL/");
        
        // Configure API key authorization: paToken
        ApiKeyAuth paToken = (ApiKeyAuth) defaultClient.getAuthentication("paToken");
        paToken.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //paToken.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ThemesServiceApi apiInstance = new ThemesServiceApi();
        // Initialize the themeApiObject parameter object for the call
        ThemeApiObject themeApiObject = ; // Create the input object for the operation, type: ThemeApiObject 

        try {
            CreatedThemeResult result = apiInstance.importTheme(themeApiObject);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ThemesServiceApi#importTheme");
            e.printStackTrace();
        }
    }
}

import * as PyramidAnalyticsWebApi from "com.pyramidanalytics";

// Create an instance of the API class
const api = new PyramidAnalyticsWebApi.ThemesServiceApi("http://Your.Server.URL")

// Configure API key authorization: paToken
api.setApiToken("YOUR API KEY");

const themeApiObject = ; // {ThemeApiObject} 

api.importTheme(themeApiObject).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});


using System;
using System.Diagnostics;
using PyramidAnalytics.Sdk.Api;
using PyramidAnalytics.Sdk.Client;
using PyramidAnalytics.Sdk.Model;

public class importThemeExample
{
    public static void Main()
    {
        Configuration conf = new Configuration();
        conf.BasePath = "http://Your.Server.URL/";
        
        
        // Configure API key authorization: paToken
        conf.ApiKey.Add("paToken", "YOUR_API_KEY");
        // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
        // conf.ApiKeyPrefix.Add("paToken", "Bearer");

        GlobalConfiguration.Instance = conf;
        
        // Create an instance of the API class
        var apiInstance = new ThemesServiceApi();
        // Initialize the themeApiObject parameter object for the call
        var themeApiObject = new ThemeApiObject(); // ThemeApiObject | 

        try {
            // Imports a theme definition from a 'PAT' file
            CreatedThemeResult result = apiInstance.importTheme(themeApiObject);
            Debug.WriteLine(result);
        } catch (Exception e) {
            Debug.Print("Exception when calling ThemesServiceApi.importTheme: " + e.Message );
        }
    }
}


import com.pyramidanalytics
from com.pyramidanalytics import ApiException
from com.pyramidanalytics import ThemesServiceApi
from pprint import pprint

        
# Configure API key authorization: paToken
api_config = com.pyramidanalytics.Configuration(host = 'http://Your.Server.URL/', api_key={ paToken:'YOUR_ACCESS_TOKEN' })

with com.pyramidanalytics.ApiClient(api_config) as api_client:
    # Create an instance of the API class
    api_instance = ThemesServiceApi(api_client)
    # Initialize the themeApiObject parameter object for the call
    themeApiObject =  # ThemeApiObject | 

    try:
        # Imports a theme definition from a 'PAT' file
        api_response = api_instance.import_theme(themeApiObject)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ThemesServiceApi->importTheme: %s\n" % e)
<?php
require_once(__DIR__ . '/vendor/autoload.php');

OpenAPITools\Client\Configuration::getDefaultConfiguration()->setHost('http://Your.Server.URL');

// Configure API key authorization: paToken
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('paToken', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('paToken', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ThemesServiceApi();
$themeApiObject = ; // ThemeApiObject | 

try {
    $result = $api_instance->importTheme($themeApiObject);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ThemesServiceApi->importTheme: ', $e->getMessage(), PHP_EOL;
}
?>